Getting Object Properties

Getting Object Properties

getCornerRadius(...)
getCornerRadius(["name"]) -> integer

Returns the corner radius of the object "name". The radius is expressed in points. If "name" is not given the currently selected item is used.

getFillColor(...)
getFillColor(["name"]) -> string

Returns the name of the fill color of the object "name". If "name" is not given the currently selected item is used.

getFillShade(...)
getFillShade(["name"]) -> integer

Returns the shading value of the fill color of the object "name". If "name" is not given the currently selected item is used.

getImageFile(...)
getImageName(["name"]) -> string

Returns the filename for the image in the image frame. If "name" is not given the currently selected item is used.

getImageScale(...)
getImageScale(["name"]) -> (x,y)

Returns a (x, y) tuple containing the scaling values of the image frame "name". If "name" is not given the currently selected item is used.

getLineCap(...)
getLineEnd(["name"]) -> integer (see constants)

Returns the line cap style of the object "name". If "name" is not given the currently selected item is used. The cap types are: CAP_FLAT, CAP_ROUND, CAP_SQUARE

getLineColor(...)
getLineColor(["name"]) -> string

Returns the name of the line color of the object "name". If "name" is not given the currently selected item is used.

getLineJoin(...)
getLineJoin(["name"]) -> integer (see contants)

Returns the line join style of the object "name". If "name" is not given the currently selected item is used. The join types are: JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND

getLineShade(...)
getLineShade(["name"]) -> integer

Returns the shading value of the line color of the object "name". If "name" is not given the currently selected item is used.

getLineStyle(...)
getLineStyle(["name"]) -> integer (see constants)

Returns the line style of the object "name". If "name" is not given the currently selected item is used. Line style constants are: LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID

getLineWidth(...)
getLineWidth(["name"]) -> integer

Returns the line width of the object "name". If "name" is not given the currently selected Item is used.

getPosition(...)
getPosition(["name"]) -> (x,y)

Returns a (x, y) tuple with the position of the object "name". If "name" is not given the currently selected item is used. The position is expressed in the actual measurement unit of the document - see UNIT_<type> for reference.

getRotation(...)
getRotation(["name"]) -> integer

Returns the rotation of the object "name". The value is expressed in degrees, and clockwise is positive. If "name" is not given the currently selected item is used.

getSize(...)
getSize(["name"]) -> (width,height)

Returns a (width, height) tuple with the size of the object "name". If "name" is not given the currently selected item is used. The size is expressed in the current measurement unit of the document - see UNIT_<type> for reference.